home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / coa_12r.zip / COA.DOC < prev    next >
Text File  |  1988-02-28  |  16KB  |  370 lines
  1. The Catacombs of ASCII
  2. ----------------------
  3.  
  4. A Game door designed by Scott L. Bain
  5. Program Version 1.2 (Release)
  6.  
  7. Welcome to COA, the online dungeon adventure system designed for
  8. PC-Board BBS's.  I hope you enjoy running the game as much as I have 
  9. enjoyed designing it.  Please feel free to contact me if you have 
  10. comment, suggestions, and especially unbridled praise.
  11.  
  12. The follwing files should be present on your
  13. distribution disk, or in your ARC file:
  14.  
  15.  COA.DOC - This file.
  16.  
  17.  COA_PLAY.DOC - Documentation for your players.  Post it as a
  18.                 bulletin, and/or as a downloadable file.  You 
  19.                 should also read it carefully as the information
  20.                 in it is not replicated in other DOC files.
  21.  
  22.  COA_EDIT.DOC - Sysop Documentation for the COA Creator/Editor.
  23.  
  24.  COA_LOAD.DOC - Sysop Documentation for the COA loader.
  25.  
  26.  COA_ADEV.DOC - Sysop Documentation for the Advanced Event features.
  27.  
  28.  COA_PLAY.EXE - The main COA exe file.  This is used as a Door from
  29.                 PC-Board.
  30.  
  31.  COA_EDIT.COM - The module to create new mazes and edit old ones.
  32.                 An Event editor is included in the program.
  33.  
  34.  COA_LOAD.COM - The module to load or re-load a maze or mazes with
  35.                 objects and monsters.  Ideally should be run as a 
  36.                 PC Board nightly event.
  37.  
  38.  COA_PLAY.SYS - The file that tells COA_PLAY which com port to use
  39.                 and where to find PCBOARD.SYS and PCBOARD.DAT as 
  40.                 written by the BBS.
  41.  
  42. Starting a game using the COA system is basically a three-step process
  43. which consists of maze creation, setting up the configuration files, and 
  44. (optionally) setting up a nightly event to reload the maze.  
  45.  
  46. Additionally, it is possible to create and then place in your maze
  47. custom-designed objects, termed `events', provided that you have the
  48. required editor and documentation.  In any case, it is suggested that
  49. you become familiar with the main game before attempting to add events.
  50.  
  51.  
  52. Maze Creation:
  53. -------------
  54. Each maze is a set of data files that store information about the game. 
  55. You can run as many different mazes as you like, with only one copy of
  56. the EXE file present in the subdirectory.  To begin, make a sub-
  57. directory on your hard disk and copy the all the files (except,
  58. perhaps, the DOC files) into it.  Next, run COA_EDIT to make your first
  59. game.
  60.  
  61. COA_EDIT can be run two ways.  You can specify the name of the maze to
  62. edit on the command line, or NEW for a new maze;
  63.  
  64.                              COA_EDIT FILENAME
  65.                                     or
  66.                                COA_EDIT NEW
  67.  
  68. Or, you can simply run COA_EDIT alone and the program will prompt you
  69. for a game name or NEW.  For now, type COA_EDIT NEW.
  70.  
  71. Follow the COA_EDIT documentation and create a maze of your own, to
  72. whatever dimensions you like.  When you are finished you will find the 
  73. following files have been created on your hard disk (the list assumes 
  74. you have called the maze MAZE_ONE, though you may call it anything you 
  75. like):
  76.  
  77. MAZE_ONE.DEF 
  78. MAZE_ONE.MAZ
  79. MAZE_ONE.PLN
  80. MAZE_ONE.PLS
  81. MAZE_ONE.EVN
  82.  
  83. These files are used by the Play module and should not be tampered with.  
  84. Use COA_EDIT to make *any* changes to your maze.  Never try to edit the
  85. game files directly.
  86.  
  87. There is an optional file that you *may* create using any ASCII text 
  88. editor, which should have the same name as the other game files but with 
  89. the extension .WEL - in this case the name would be MAZE_ONE.WEL if you 
  90. elected to create it.  It is simply a welcome message that will be 
  91. displayed to the player when he or she first opens the door and begins 
  92. play.  It is especially recommeded that you create this file if you are 
  93. running more than one game or if you would like to have the name of your 
  94. board appear in the game somewhere.
  95.  
  96. There are two more game files that will be created as soon as the game 
  97. as been played at least once.  They are (again, assuming the name 
  98. MAZE_ONE for the game):
  99.  
  100. MAZE_ONE.LOG
  101. MAZE_ONE.LST
  102.  
  103. The .LOG file is used by the system to store messages for the players to 
  104. inform them of what has happened to them since they were last on.  
  105. Again, do not try to edit this file with a standard text editor.  Just 
  106. let the system update it as need be.
  107.  
  108. The .LST file is a list of the top ten scorers in the game and should be 
  109. copied to a bulletin in your system at the end of the calling batch.  
  110. This is, of course, optional, but players tend to become more 
  111. enthusiastic when they see their name `in print'...
  112.  
  113. In addition, COA will create a file called SYSLOG which will show you all
  114. activity on all COA games you are currently running. This is a log like
  115. the PC-Board callers log... you can delete it any time you like as it
  116. will simply grow and grow as the game(s) are played.
  117.  
  118. If the system encounters an error, SYSERR will be written.  If this
  119. happens, please contact me immediately so I can repair the bug. 
  120. Exceptions are error #24, which simply means that your caller hung up
  121. during a game (shame on him) and error #25, which means the user timed
  122. out on the keyboard and the game automatically recycled into PC-Board.
  123.  
  124.  
  125. SETTING UP THE CONFIGURATION FILES:
  126. ----------------------------------
  127.  
  128. First, create/edit the file COA_PLAY.SYS with any ASCII text editor.
  129. The file must contain three lines, and only three.  The first line must 
  130. be the name of the COM port your system uses, ie COM1: or COM2:.  The 
  131. second line should be the entire path/file name of your PCBOARD.SYS 
  132. file.  The third line should be the entire path/file name of your 
  133. PCBOARD.DAT file.  Commonly, the file would look like this:
  134.  
  135. COM1:
  136. C:\PCB\PCBOARD.SYS
  137. C:\PCB\PCBOARD.DAT
  138.  
  139. It is absolutley essential that this file be correct.  Otherwise, 
  140. nothing about the play module will function...
  141.  
  142. Second, you must create a calling batch for PC-Board to use when opening 
  143. the door into the game.  See your PC-Board documentation for details on 
  144. this, keeping the following in mind:
  145.  
  146. 1 - Do NOT use watchdog or CTTY or Gateway, or any other Door redirect/
  147.     monitor program.  COA was designed with all needed checks and
  148.     redirection built in.  You can even play COA when logged on locally,
  149.     and the system will adjust.
  150.  
  151. 2 - The batch should call COA_PLAY like this:  COA_PLAY MAZE_ONE
  152.     (assuming yet again that the game is called MAZE_ONE.  If you
  153.     have multiple games running you can have different calling
  154.     batches...).  If you put just COA_PLAY in the batch, the user
  155.     will be asked to enter the game name.  This may be one way to
  156.     run multiple games without creating multiple doors.
  157.  
  158. 3 - Your calling batch should ideally copy the file MAZE_ONE.LST, or
  159.     whatever, to a BLT file somewhere in your BBS directory structure
  160.     so your players can watch the game progress and see their part
  161.     in it.
  162.  
  163.     An example calling batch:
  164.  
  165.     ECHO OFF
  166.     CD \PCB\DOORS\COA
  167.     COA_PLAY MAZE_ONE
  168.     COPY MAZE_ONE.LST \PCB\GAMES\GBLT1
  169.     CD \PCB
  170.     BOARD
  171.  
  172.  
  173. SETTING UP THE NIGHTLY RELOAD:
  174. -----------------------------
  175.  
  176. Most of this is covered in the COA_LOAD.DOC file, but it should be noted
  177. here that the file COA_LOAD.DAT should be edited with any ASCII text
  178. editor, and the call to COA_LOAD should be in your EVENT.SYS file under
  179. your PC-Board subdirectory (usually \PCB).
  180.  
  181.  
  182. EVENTS
  183. ------
  184.  
  185. Events are utterly optional and quite complicated.  Suffice it to say
  186. here that Events allow you, the designer of the maze, to create special
  187. objects and `happenings' which can affect the player in virtually any
  188. way, create and destroy monsters and objects, alter the maze itself,
  189. etc...
  190.  
  191. Consult COA_EDIT.DOC & COA_ADEV.DOC for more information on Events.
  192.  
  193.  
  194. If you have any questions, or if your ARC file or distribution disk was 
  195. missing a file or files, you can contact The Scanline Remote for 
  196. whatever you need.
  197.  
  198.  ------- Notice of Copyright -----------------------------------------
  199. |                                                                     |
  200. | This program and all related documents and support files are copy-  |
  201. | righted by Scott L. Bain, 1988.  Author releases the executable and |
  202. | support files for public usage without license, so long as none of  |
  203. | the program, documentation, or support files are altered in any way |
  204. | by the receiver.  Files may be copied and transferred to other      |
  205. | individuals, so long as the terms stated here are met, and NO FEES  |
  206. | of ANY KIND are levied for such distribution, including but not     |
  207. | limited to P.D. disk distribution services AND PAY BULLETIN BOARD   |
  208. | SYSTEMS.  Disassembly/modification of the code is prohibited.       |
  209.  ---------------------------------------------------------------------
  210.  
  211. My sincere thanks to the following individuals who have helped playtest
  212. and/or beta test the COA system (listed almost alphabetically):
  213.  
  214.  
  215.                        Andrea Bain (Aithne)
  216.                        Christopher Bain (Maxfield)
  217.                        Rick Bickmore (Robin Hood) 
  218.                        Brad Chesbro (Balthazar)
  219.                        Greg Dooley (Columbo)
  220.                        Paul Ephron (???????)
  221.                        Garlord Fenton (Farley)
  222.                        Tony Gentile (RASV)
  223.                        Joe Halloway (Torque)
  224.                        Lloyd Helm (Logan)
  225.                        Keith Helm (Killer)
  226.                        Paul Huizenga (The Crumpus)
  227.                        Eric Knowles (Eric the Red)
  228.                        Mike Nielsen (Bac'Tilar) 
  229.                        Danny Powers (Karaz)
  230.                        Darryl Thierry (Suicidal)
  231.                        Ethian Androgos, Master of Steel
  232.  
  233.  
  234.  
  235.                                                         Scott L. Bain
  236.                                                      The Scanline Remote
  237.                                                         2400/1200/300
  238.                                                         (619)298-2023
  239.  
  240.  
  241. REVISION HISTORY
  242. ----------------
  243.  
  244. 12/01/87  Version 1.0 release after three months of testing, in which
  245.           beta versions 1.0 through 2.3 were issued to test systems.
  246.  
  247. 12/30/87  Version 1.1 corrects two bugs concerning the reditribution of
  248.           objects when a player dies; Object are NEVER placed over other
  249.           objects or terrain even in a very crowded maze.  Also, the
  250.           EVENT objects a player possess are only distributed if they
  251.           are Gettable.
  252.  
  253.           Version 1.1 supports a wider variety of modem types.
  254.  
  255.           Version 1.1 removes O, P, M notation from Inspect, thus allowing
  256.           more secretive events.
  257.  
  258.           Version 1.1 fixes MVP bug in events.
  259.  
  260.           Version 1.1 COA_EDIT fixes bug in event totalling.
  261.  
  262.           Version 1.1 COA_LOAD allows Random level placement.
  263.  
  264.           Version 1.1 COA_EDIT and COA_EVNT combined into one program.
  265.  
  266. 02/29/88  Version 1.2 COA_PLAY corrects the Ghosting bug.  Under certain
  267.           circumstances including mid-game system crashes, players may
  268.           become `ghosted'.  A second version of the player exists in
  269.           the maze array, which can be attacked and killed over and
  270.           over again by other players.  COA_PLAY automatically purges
  271.           these ghosts as they are encountered (before players even see
  272.           them), and COA_LOAD also checks for them each night and
  273.           destroys them as found.
  274.  
  275.           Version 1.2 COA_PLAY no longer gives terminal errors on carrier
  276.           drop - this was one of the ghosting causes.  I hate call waiting.
  277.  
  278.           Version 1.2 COA_PLAY fixes FIRE AT (F) event trigger.  It worked
  279.           in 1.0, but not 1.1.  A mystery to me....
  280.  
  281.           Version 1.2 COA_PLAY Events can now be stacked, to allow for more
  282.           than one trigger/effect per event, and chained, to allow for
  283.           more than one effect per trigger.  See COA_ADEV.DOC for details.
  284.           Use with caution; very powerful.
  285.  
  286.           Version 1.2 COA_PLAY does not allow an event object which is in 
  287.           the player's possession but which does not have G has a trigger
  288.           to be Put back down, nor will it be randomized when he dies.  See
  289.           COA_EDIT.DOC for details.
  290.        
  291.           Version 1.2 Event Effect - TGL: Toggles two objects.
  292.            
  293.           Version 1.2 Event Effect - DPF: Displays a Text File.
  294.  
  295.           Version 1.2 Event Effect - GVP: Give player an object, 
  296.           if he has room to carry it.
  297.  
  298.           Version 1.2 Event Effect - TKO: Take a specified object from
  299.           the player, either by obj number, or by what is in a hand.
  300.  
  301.           Version 1.2 Event Trigger - M: Event objects can now be read. 
  302.           Very useful with the new DPF command...
  303.  
  304.           Version 1.2 Event Trigger - X: Generic `Use it' trigger.
  305.  
  306.           Version 1.2 Event Trigger - P: Object triggered when Put. 
  307.           Take care to transform after the Put to an object with some
  308.           other trigger (or use event stacking...)!
  309.  
  310.           Version 1.2 Trigger Parameter - Now can check to see that the
  311.           player has at least x gold before event will trigger.  Make
  312.           your own shops! Also, you can check to see if the player has
  313.           at least x str.
  314.  
  315.           Version 1.2 Trigger Parameter - Now you can use other trigger
  316.           params with G than POSSESS.  If POSSESS is not used, any of
  317.           the other param forms may be.
  318.  
  319.           Version 1.2 Events: CDx now allows player to choose direction
  320.           for an event's effect.  Useful for keys, special weapons,
  321.           etc...
  322.  
  323.           Version 1.2 Events: CPS fixed to disallow modification of 21,
  324.           22 and 23, which caused ghosting.  Also added optional MIN
  325.           MAX feature to prevent subzero or overly large values to be
  326.           created by a CPS call.
  327.  
  328.           Version 1.2 Events: O trigger events will now trigger each turn
  329.           the player remains on them.  In other words, if a player does
  330.           anything other than move off the space containing the event,
  331.           it will trigger again.  This was the way I always intended it
  332.           to work; it just did not work before.
  333.  
  334.           Version 1.2 COA_PLAY: Changed Opfire such that a player will stay
  335.           in opfire mode until he is attacked (melee) or runs out of bolts.
  336.           The `auto exit on one fire' was unfair and made opfire rather
  337.           impotent.
  338.  
  339.           Version 1.2 COA_PLAY: Event Objects with an invisible
  340.           (ALT-255) description name may not be spoken to, gotten, or
  341.           attacked.  This way, the object is truly not visible. 
  342.           `Attack ?' was a nonsense message that ruined the effect of
  343.           an object that was supposed to look like a floorspace, etc...
  344.  
  345.           Version 1.2 COA_LOAD now allows nightly loading of event objects.
  346.           Be careful with this feature!  Very very careful!  Read 
  347.           COA_LOAD.DOC before you attempt to use this feature!
  348.  
  349.           Version 1.2 COA_EDIT seperates Event Editing and Reporting into
  350.           two menu items, responding to numerous complaints from sysops and
  351.           designers alike.
  352.  
  353.           Version 1.2 COA_EDIT Does some minor syntax checking and default
  354.           prep, as well as adding /A to adjust large mazes for running under
  355.           Double Dos.
  356.    
  357.           Version 1.2 COA_EDIT now allows the designer/sysop to specify
  358.           which level of the maze a new or reborn player will appear on.
  359.           Leave this at 0 for most mazes.
  360.  
  361.           Version 1.2 COA_EDIT maze editor: The status line at the bottom
  362.           of the screen now displays the number first for object and
  363.           player, and the name second.  This way long names do not push
  364.           the number out of the viewable range.
  365.  
  366.           NOTE: 1.2 Released with possible bug for those using EMS
  367.           extended memory.  You may get STRING SPACE CORRUPT if you
  368.           are using an older board.  Cannot seem to fix this...
  369.  
  370.